Skip to content

docs(site): state the shape a tutorial keeps and what a shown request proves - #919

Closed
jeremi wants to merge 2 commits into
mainfrom
docs/style-guide-tutorial-shape
Closed

jeremi wants to merge 2 commits into
mainfrom
docs/style-guide-tutorial-shape

Conversation

@jeremi

@jeremi jeremi commented Sep 7, 2026

Copy link
Copy Markdown
Member

Rules the two BReg tutorial rewrites in #918 needed and the style guide did not yet state.

  • A tutorial keeps a command or a line to check on every screen; inventories go to reference, models to explanation, and a public quickstart the reader knows is a fair shape benchmark.
  • A request shown on a page was sent as written to a running instance; a body inferred from a schema is a guess.
  • When a change alters what a command prints, every page quoting that command is in scope.
  • The generated CLI reference is draft on the unreleased docset, so current pages send readers to --help instead of linking into it.
  • Writing review gains a seventh question that measures shape.

Vale and markdownlint pass. Prose only, no page content changed.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 7, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-24T16:43:31.481387Z dc2d913 New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 7787ed6513

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/site/AGENTS.md
@jeremi
jeremi enabled auto-merge (squash) September 7, 2026 17:35
@jeremi
jeremi disabled auto-merge September 7, 2026 17:35

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b955ead8ca

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/site/docs/style-guide.md Outdated
Comment thread docs/site/docs/style-guide.md Outdated
… proves

Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
@jeremi
jeremi enabled auto-merge September 24, 2026 16:41
@jeremi
jeremi force-pushed the docs/style-guide-tutorial-shape branch from b955ead to dc2d913 Compare September 24, 2026 16:41

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: dc2d9133aa

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/site/AGENTS.md
… the CLI link rule to its review record

Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
@jeremi
jeremi disabled auto-merge September 24, 2026 17:22
@jeremi jeremi closed this Sep 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant